Show:

ia.DataGroup Class

Defined in: ia\DataGroup.js:1
Module: ia

Responsible for holding information abut the data for a group of components.

Constructor

ia.DataGroup

(
  • report
  • suffix
)

Defined in ia\DataGroup.js:1

Parameters:

  • report ia.Report

    The report object.

  • suffix Number

    The component suffix.

Methods

addEventListener

(
  • eventType
  • fnc
  • obj
)

Add an event listener.

Parameters:

  • eventType String

    The type of event to listen for.

  • fnc Function

    The function to call when the event occurs.

  • obj Object

    An optional parent object.

build

(
  • callbackFnc
)

Defined in ia\DataGroup.js:256

Builds the datagroup.

Parameters:

  • callbackFnc Function

    Gets called when the DataGroup is complete.

checkForCustomThemeProperties

(
  • me.thematic
  • indicator
)
private

Defined in ia\DataGroup.js:659

Checks if the loaded indicator has custom legend properties.

Parameters:

clearFilter

()

Defined in ia\DataGroup.js:223

Clears the filter.

dispatchEvent

(
  • event
)

Dispatch an event to the listeners.

Parameters:

  • event Object

    The event object.

getFilterFeatures

() String

Defined in ia\DataGroup.js:212

Gets the list of filtered features.

Returns:

String: A list of feature ids.

initData

() private

Defined in ia\DataGroup.js:331

Initialises the data for first use.

onDataChanged

() private

Defined in ia\DataGroup.js:560

Called after the data have changed - this can be if a new indicator has been selected or if a filter has been applied.

onGeographyChanged

(
  • indicator
)
private

Defined in ia\DataGroup.js:449

Called after a geography has changed.

Parameters:

onIndicatorChanged

(
  • indicator
)
private

Defined in ia\DataGroup.js:424

Called after an indicator has changed.

Parameters:

removeListener

(
  • obj
)

Removes all event listeners for the given object.

Parameters:

  • obj Object

    The object.

render

() private

Defined in ia\DataGroup.js:604

Responsible for rendering all the components.

setData

(
  • geogId
  • indicatorId
  • date
)

Defined in ia\DataGroup.js:143

Loads a new indicator.

Parameters:

  • geogId String

    The geog id.

  • indicatorId String

    The indicator id.

  • date String

    The date.

setFeatureFilter

(
  • featureList
)

Defined in ia\DataGroup.js:190

Filters the data group on a list of feature ids.

Parameters:

  • featureList String

    a list of feature ids.

setFilter

(
  • filterId
  • filterValue
)

Defined in ia\DataGroup.js:167

Sets a new filter.

Parameters:

  • filterId String

    The filter id.

  • filterValue String

    The filter value.

update

(
  • callbackFnc
)

Defined in ia\DataGroup.js:244

Call this to update the DataGroup when the data.js has been changed.

Parameters:

  • callbackFnc Function

    Called on completion of function.

updateData

(
  • geogId
  • indicatorId
  • date
)
private

Defined in ia\DataGroup.js:387

Loads a new indicator.

Parameters:

  • geogId String

    The geog id.

  • indicatorId String

    The indicator id.

  • date String

    The date.

updateStats

() private

Defined in ia\DataGroup.js:778

Updates the statictics substitution variables.

updateThematicParams

() private

Defined in ia\DataGroup.js:733

Updates the params for the thematics.

Properties

comparisonData

Object

Defined in ia\DataGroup.js:89

The comparison data.

comparisonThematic

ia.Thematic

Defined in ia\DataGroup.js:121

The comparison thematic.

comparisonThemeData

Object

Defined in ia\DataGroup.js:105

The comparison theme data.

geography

ia.Geography

Defined in ia\DataGroup.js:57

The selected geography.

indicator

ia.Indicator

Defined in ia\DataGroup.js:73

The selected indicator.

indicatorData

Object

Defined in ia\DataGroup.js:81

The indicator data.

legendSettings

Object

Defined in ia\DataGroup.js:129

holder for the legend settings.

mapData

ia.MapData

Defined in ia\DataGroup.js:49

The map data.

me.thematic

ia.Thematic

Defined in ia\DataGroup.js:113

The thematic.

suffix

String

Defined in ia\DataGroup.js:41

The suffix for the data group.

theme

ia.Theme

Defined in ia\DataGroup.js:65

The selected theme.

themeData

Object

Defined in ia\DataGroup.js:97

The theme data.